Class PointCloudVisualizerSettings
ScriptableObject settings for the PointCloud visualizer. Mirrors the channel and color-mode configuration of PointCloud2VisualizerSettings for the legacy sensor_msgs/PointCloud message type.
Inheritance
Inherited Members
Namespace: Global Namespace
Assembly: Unity.SimulationPro.Foundation.Visualizations.dll
Syntax
[CreateAssetMenu(fileName = "PointCloudVisualizerSettings", menuName = "Robotics/Sensor Visualizers/PointCloud", order = 1)]
public class PointCloudVisualizerSettings : VisualizerSettingsGeneric<PointCloudMsg>
Properties
BChannel
Gets or sets the channel name used as the blue color component.
Declaration
public string BChannel { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
BRange
Gets or sets the [min, max] range for normalizing the blue channel.
Declaration
public float[] BRange { get; set; }
Property Value
| Type | Description |
|---|---|
| float[] |
Channels
Gets or sets the channel names present in the most recently received message.
Declaration
public string[] Channels { get; set; }
Property Value
| Type | Description |
|---|---|
| string[] |
ColorMode
Gets or sets the active color mode for deriving per-point colors from named channels.
Declaration
public PointCloud2VisualizerSettings.ColorMode ColorMode { get; set; }
Property Value
| Type | Description |
|---|---|
| PointCloud2VisualizerSettings.ColorMode |
GChannel
Gets or sets the channel name used as the green color component.
Declaration
public string GChannel { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
GRange
Gets or sets the [min, max] range for normalizing the green channel.
Declaration
public float[] GRange { get; set; }
Property Value
| Type | Description |
|---|---|
| float[] |
HueChannel
Gets or sets the channel name used as the HSV hue source.
Declaration
public string HueChannel { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
HueRange
Gets or sets the [min, max] range for normalizing the hue channel.
Declaration
public float[] HueRange { get; set; }
Property Value
| Type | Description |
|---|---|
| float[] |
RChannel
Gets or sets the channel name used as the red color component.
Declaration
public string RChannel { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
RRange
Gets or sets the [min, max] range for normalizing the red channel.
Declaration
public float[] RRange { get; set; }
Property Value
| Type | Description |
|---|---|
| float[] |
RgbChannel
Gets or sets the channel name that provides a packed RGB value.
Declaration
public string RgbChannel { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
Size
Gets or sets the base point radius in world units used when UseSizeChannel is false.
Declaration
public float Size { get; set; }
Property Value
| Type | Description |
|---|---|
| float |
SizeChannel
Gets or sets the channel name used as a per-point radius source when UseSizeChannel is true.
Declaration
public string SizeChannel { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
SizeRange
Gets or sets the [min, max] range for normalizing the size channel when UseSizeChannel is true.
Declaration
public float[] SizeRange { get; set; }
Property Value
| Type | Description |
|---|---|
| float[] |
UseRgbChannel
Gets or sets whether a color channel drives per-point colors.
Declaration
public bool UseRgbChannel { get; set; }
Property Value
| Type | Description |
|---|---|
| bool |
UseSeparateRgb
Gets or sets whether RGB components are read from three separate channels rather than a single packed channel.
Declaration
public bool UseSeparateRgb { get; set; }
Property Value
| Type | Description |
|---|---|
| bool |
UseSizeChannel
Gets or sets whether a size channel drives per-point radius rather than the fixed Size.
Declaration
public bool UseSizeChannel { get; set; }
Property Value
| Type | Description |
|---|---|
| bool |
Methods
CreateGUI(PointCloudMsg, MessageMetadata)
Creates a GUI callback that renders an Inspector panel for the message data.
Declaration
public override Action CreateGUI(PointCloudMsg message, MessageMetadata meta)
Parameters
| Type | Name | Description |
|---|---|---|
| PointCloudMsg | message | The message data to visualize. |
| MessageMetadata | meta | Metadata about the received message (topic, timestamp, frame). |
Returns
| Type | Description |
|---|---|
| Action | An action that draws the GUI. |
Overrides
Draw(Drawing3d, PointCloudMsg, MessageMetadata, Transform)
Draws a 3D visualization of the message data.
Declaration
public override void Draw(Drawing3d drawing, PointCloudMsg message, MessageMetadata meta, Transform visualizerTransform)
Parameters
| Type | Name | Description |
|---|---|---|
| Drawing3d | drawing | The 3D drawing context to render into. |
| PointCloudMsg | message | The message data to visualize. |
| MessageMetadata | meta | Metadata about the received message (topic, timestamp, frame). |
| Transform | visualizerTransform | The visualizerTransform. |